Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1229 +/- ##
=======================================
Coverage 89.74% 89.74%
=======================================
Files 57 57
Lines 8195 8195
Branches 8195 8195
=======================================
Hits 7355 7355
Misses 544 544
Partials 296 296 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
Adds the v2.1.0 release notes and aligns repository metadata for the upcoming release, while also correcting process-related input schema column names.
Changes:
- Add
docs/release_notes/v2.1.0.mdand clear outupcoming.mdnow that notes have been “cut” for the release. - Fix schema column naming for process-related inputs by renaming
years→commission_years. - Bump crate version to
2.1.0and update release metadata (CITATION.cff, docs summary).
Reviewed changes
Copilot reviewed 8 out of 9 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| schemas/input/process_parameters.yaml | Rename years field to commission_years and update notes wording. |
| schemas/input/process_flows.yaml | Rename years field to commission_years and update notes wording. |
| schemas/input/process_availabilities.yaml | Rename years field to commission_years. |
| docs/release_notes/v2.1.0.md | Add v2.1.0 release notes content. |
| docs/release_notes/upcoming.md | Remove prior “upcoming” entries after moving into v2.1.0 notes. |
| docs/SUMMARY.md | Add v2.1.0 release notes entry to the documentation summary. |
| Cargo.toml | Bump package version to 2.1.0. |
| Cargo.lock | Update lockfile version entry for muse2 to 2.1.0. |
| CITATION.cff | Update citation metadata for v2.1.0 (version/date formatting). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 10 out of 11 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| This release represents over 5 months of development since v2.0.0, adding a number of exciting new | ||
| features, as well as some small improvements, bug fixes, and underlying code changes designed to | ||
| improve performance and maintainability. |
There was a problem hiding this comment.
Many lines in this new release note exceed the repo’s markdownlint MD013 limit (100 chars) and are likely to fail the pre-commit markdownlint-fix hook. Please reflow/wrap the paragraphs and long list items (or explicitly disable MD013 for this file if intentional).
|
@alexdewar Link checker failing. Can we not use relative links? They all work for me locally |
alexdewar
left a comment
alexdewar
left a comment
There was a problem hiding this comment.
This is excellent! Good work 😄
Like you say, even we could get away with less detail for this release, it's good to get into the habit for future. Having it as part of the documentation trail for the project is useful too.
Good job spotting the errors in the schemas... that reminds me that I started working on #623 ages ago, but never finished it. Maybe worth picking up again for the next engagement.
I figured out why the link checker was complaining (see comment). For future reference, we use lychee as a link checker and you can run it locally (it's a Rust program, so can be installed with cargo), e.g. lychee --exclude-path ^target .
Requesting changes because of the link checker thing.
There was a problem hiding this comment.
I guess this file has been reformatted because the prettier pre-commit hook doesn't recognise it as a YAML file. We could probably tweak things in the .pre-commit-config.yaml file so this also gets formatted by prettier, but possibly not worth the effort 😛
There was a problem hiding this comment.
I just did cmd-s out of habit while working on this file and then this happened, not sure why
| - family-names: Scharpf | ||
| given-names: Benjamin | ||
| - family-names: Karimi | ||
| given-names: Aurash |
There was a problem hiding this comment.
I guess @Aurashk might have an ORCID too, but I couldn't find one on his GitHub page or Imperial profile. Probably doesn't matter much...
docs/release_notes/v2.1.0.md
Outdated
| [`demand.csv`]: ../file_formats/input_files.html#demandcsv | ||
| [`processes.csv`]: ../file_formats/input_files.html#processescsv | ||
| [`process_flows.csv`]: ../file_formats/input_files.html#process_flowscsv | ||
| [`process_availabilities.csv`]: ../file_formats/input_files.html#process_availabilitiescsv | ||
| [`process_parameters.csv`]: ../file_formats/input_files.html#process_parameterscsv | ||
| [`process_investment_constraints.csv`]: ../file_formats/input_files.html#process_investment_constraintscsv | ||
| [`commodities.csv`]: ../file_formats/input_files.html#commoditiescsv | ||
| [`commodity_levies.csv`]: ../file_formats/input_files.html#commodity_leviescsv | ||
| [`model.toml`]: ../file_formats/input_files.html#model-parameters-modeltoml | ||
| [`assets.csv`]: ../file_formats/input_files.html#assetscsv | ||
| [`settings.toml`]: ../file_formats/program_settings.html |
There was a problem hiding this comment.
The reason the link checker is complaining is because it checks links in both markdown and HTML files separately. So these links will work for the generated docs in book/, but when it's looking at the raw markdown, they won't (there's no input_files.html file, just input_files.md).
You could shut it up by just changing the .html extensions to .md, but then these links won't work when we paste this text into the release description box for the actual release. To make this work, we'll need absolute links. Ideally, these would point to the v2.1.0 version of the docs in case we break these links in future, but alas, that doesn't exist yet! Bit of a 🐔 and 🥚 situation... Ideas for this welcome 😄 .
Anyway, this should do for now:
| [`demand.csv`]: ../file_formats/input_files.html#demandcsv | |
| [`processes.csv`]: ../file_formats/input_files.html#processescsv | |
| [`process_flows.csv`]: ../file_formats/input_files.html#process_flowscsv | |
| [`process_availabilities.csv`]: ../file_formats/input_files.html#process_availabilitiescsv | |
| [`process_parameters.csv`]: ../file_formats/input_files.html#process_parameterscsv | |
| [`process_investment_constraints.csv`]: ../file_formats/input_files.html#process_investment_constraintscsv | |
| [`commodities.csv`]: ../file_formats/input_files.html#commoditiescsv | |
| [`commodity_levies.csv`]: ../file_formats/input_files.html#commodity_leviescsv | |
| [`model.toml`]: ../file_formats/input_files.html#model-parameters-modeltoml | |
| [`assets.csv`]: ../file_formats/input_files.html#assetscsv | |
| [`settings.toml`]: ../file_formats/program_settings.html | |
| <!-- Use absolute links so they work when we paste into release notes box --> | |
| [`demand.csv`]: https://energysystemsmodellinglab.github.io/MUSE2/file_formats/input_files.html#demandcsv | |
| [`processes.csv`]: https://energysystemsmodellinglab.github.io/MUSE2/file_formats/input_files.html#processescsv | |
| [`process_flows.csv`]: https://energysystemsmodellinglab.github.io/MUSE2/file_formats/input_files.html#process_flowscsv | |
| [`process_availabilities.csv`]: https://energysystemsmodellinglab.github.io/MUSE2/file_formats/input_files.html#process_availabilitiescsv | |
| [`process_parameters.csv`]: https://energysystemsmodellinglab.github.io/MUSE2/file_formats/input_files.html#process_parameterscsv | |
| [`process_investment_constraints.csv`]: https://energysystemsmodellinglab.github.io/MUSE2/file_formats/input_files.html#process_investment_constraintscsv | |
| [`commodities.csv`]: https://energysystemsmodellinglab.github.io/MUSE2/file_formats/input_files.html#commoditiescsv | |
| [`commodity_levies.csv`]: https://energysystemsmodellinglab.github.io/MUSE2/file_formats/input_files.html#commodity_leviescsv | |
| [`model.toml`]: https://energysystemsmodellinglab.github.io/MUSE2/file_formats/input_files.html#model-parameters-modeltoml | |
| [`assets.csv`]: https://energysystemsmodellinglab.github.io/MUSE2/file_formats/input_files.html#assetscsv | |
| [`settings.toml`]: https://energysystemsmodellinglab.github.io/MUSE2/file_formats/program_settings.html |
There was a problem hiding this comment.
I'm wondering how this works with different versions of the documentation. In this case it would make most sense to point to the documentation for v2.1.0, but in general it makes most sense for intra-documentation links to point to the same version of the documentation as what we're currently looking at. As it stands, I think all absolute links are going to point to the latest version of the docs, which is annoying if you're looking at the documentation for an old version, click a link, and now suddenly you're looking at documentation for the newest version, probably without even realising
There was a problem hiding this comment.
I've done what you've suggested for now. To be honest, I'm not sure we really need to put the full release notes in the description box for the release - for MUSE1 I always just copy a link to the actual release notes in the documentation
Description
Release notes for the upcoming v2.1.0 release, designed to capture user-relevant changes since v2.0.0 (d544d65). I'm sure I've probably missed something so please shout if you (or the AI) spot anything or have any other suggestions.
These are probably far more user facing than they have any right to be at this stage, given our tiny user base, but I think it's not a bad idea to start as we mean to go on. I thought it was a nice idea to include a list of breaking changes to make it really clear what changes users will need to make to existing files to work with the new version, even if some of this is a rehash of points previously mentioned.
I've put a tentative date of March 31st, given our original aim to get this out before the end of March, but this can be changed if needed.
Also found some schema errors in the
process_files.Fixes #1218
Type of change
Key checklist
$ cargo test$ cargo docpresent in the previous release
Further checks